@xmpp/jid

JID

XMPP identifiers (JID) for JavaScript

JID type	local	@	domain	/	resource	usage
domain			wonderland.net			servers and components
bare	alice	@	wonderland.net			users
full	alice	@	wonderland.net	/	rabbithole	user resource (device)

https://en.wikipedia.org/wiki/XMPP#Decentralization_and_addressing

Install

npm install @xmpp/jid

Usage

var jid = require("@xmpp/jid");

/*
 * All return an instance of jid.JID
 */
var addr = jid("[e-mail]/rabbithole");
var addr = jid("alice", "wonderland.net", "rabbithole");

addr instanceof jid.JID; // true

// domain JIDs are created passing the domain as the first argument
var addr = jid("wonderland.net");

/*
 * local
 */
addr.local = "alice";
addr.local; // alice
// same as
addr.setLocal("alice");
addr.getLocal(); // alice

/*
 * domain
 */
addr.domain = "wonderland.net";
addr.domain; // wonderland.net
// same as
addr.setDomain("wonderland.net");
addr.getDomain(); // wonderland.net

/*
 * resource
 */
addr.resource = "rabbithole";
addr.resource; // rabbithole
// same as
addr.setResource("rabbithole");
addr.getResource(); // rabbithole

addr.toString(); // [e-mail]/rabbithole
addr.bare(); // returns a JID without resource

addr.equals(some_jid); // returns true if the two JIDs are equal, false otherwise
// same as
jid.equal(addr, some_jid);

Escaping

The XEP-0106 defines a method to escape and unescape characters that aren't allowed in the local part of the JID. This library fully implement it.

const addr = jid("[e-mail]", "xmpp.net");
addr.toString(); // contact\[e-mail]
// for display purpose only
addr.toString(true); // [e-mail]@xmpp.net

For user input, use

jid("[e-mail]", "xmpp.net");
// over
jid("[e-mail]@xmpp.net");

References

• RFC 7622 XMPP Address Format mostly implemented, l10n WIP
• XEP-0106 JID Escaping implemented

Deprecated

• XEP-0029 Definition of Jabber Identifiers (JIDs) 2003
• RFC 3920 XMPP addressing 2004
• RFC 3920 XMPP Address Format 2011